Gets the offset from the beginning of a sound resource to the embedded sound header.

OSErr GetSoundHeaderOffset (
    SndListHandle sndHandle, 
    SInt32 *offset
);

Parameter descriptions

sndHandle

A handle to a sound resource. The handle passed to GetSoundHeaderOffset does not have to be locked.

offset

On return, a pointer to the offset, in bytes, from the beginning of the sound resource specified by the sndHdl parameter to the beginning of the sound header within that sound resource. You might need this information if you want to use the address of that sound header in a sound command (such as the soundCmd or bufferCmd sound command).

function result

A result code.

SPECIAL CONSIDERATIONS

You can call the GetSoundHeaderOffset function at interrupt time.

VERSION NOTES

The GetSoundHeaderOffset function is available only in version 3.0 and later of the Sound Manager.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.

© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)